<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Faiss: /data/users/hoss/faiss/IndexIVF.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Faiss
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">/data/users/hoss/faiss/IndexIVF.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) Facebook, Inc. and its affiliates.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * This source code is licensed under the MIT license found in the</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * LICENSE file in the root directory of this source tree.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">// -*- c++ -*-</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef FAISS_INDEX_IVF_H</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define FAISS_INDEX_IVF_H</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &quot;Index.h&quot;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor">#include &quot;InvertedLists.h&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;Clustering.h&quot;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;Heap.h&quot;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span>faiss {</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">/** Encapsulates a quantizer object for the IndexIVF</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> * The class isolates the fields that are independent of the storage</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * of the lists (especially training)</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html">   31</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">   32</a></span>&#160;    <a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>;        <span class="comment">///&lt; quantizer that maps vectors to inverted lists</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">   33</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">nlist</a>;             <span class="comment">///&lt; number of possible key values</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">    /**</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">     * = 0: use the quantizer as index in a kmeans training</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment">     * = 1: just pass on the training set to the train() of the quantizer</span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">     * = 2: kmeans training on a flat index + add the centroids to the quantizer</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a1dcea762fc322fdcffe64f78994edea0">   40</a></span>&#160;    <span class="keywordtype">char</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1dcea762fc322fdcffe64f78994edea0">quantizer_trains_alone</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#ab688c629cd42122d73517078b87f483d">   41</a></span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#ab688c629cd42122d73517078b87f483d">own_fields</a>;          <span class="comment">///&lt; whether object owns the quantizer</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#abb7097ed40b15ba0af08af6d03608f72">   43</a></span>&#160;    <a class="code" href="structfaiss_1_1ClusteringParameters.html">ClusteringParameters</a> <a class="code" href="structfaiss_1_1Level1Quantizer.html#abb7097ed40b15ba0af08af6d03608f72">cp</a>; <span class="comment">///&lt; to override default clustering params</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="structfaiss_1_1Level1Quantizer.html#a45d29dd6a5c53789c08e5ceb3f63d989">   44</a></span>&#160;<span class="comment"></span>    <a class="code" href="structfaiss_1_1Index.html">Index</a> *<a class="code" href="structfaiss_1_1Level1Quantizer.html#a45d29dd6a5c53789c08e5ceb3f63d989">clustering_index</a>; <span class="comment">///&lt; to override index used during clustering</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">    /// Trains the quantizer and calls train_residual to train sub-quantizers</span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a0069a6ee1e32c2e0c1c7df9a95740dd4">train_q1</a> (<span class="keywordtype">size_t</span> n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, <span class="keywordtype">bool</span> verbose,</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;                   <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric_type);</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> (<a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">nlist</a>);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> ();</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    ~<a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> ();</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;};</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="structfaiss_1_1IVFSearchParameters.html">   60</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IVFSearchParameters.html">IVFSearchParameters</a> {</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structfaiss_1_1IVFSearchParameters.html#a1183c0b7d9ffd5154b32765175f2a9cc">   61</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IVFSearchParameters.html#a1183c0b7d9ffd5154b32765175f2a9cc">nprobe</a>;            <span class="comment">///&lt; number of probes at query time</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structfaiss_1_1IVFSearchParameters.html#ac3e01728f6376ad727340525b2138782">   62</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IVFSearchParameters.html#ac3e01728f6376ad727340525b2138782">max_codes</a>;         <span class="comment">///&lt; max nb of codes to visit to do a query</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1IVFSearchParameters.html">IVFSearchParameters</a> () {}</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;};</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="keyword">struct </span>InvertedListScanner;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment">/** Index based on a inverted file (IVF)</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> * In the inverted file, the quantizer (an Index instance) provides a</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> * quantization index for each vector to be added. The quantization</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> * index maps to a list (aka inverted list or posting list), where the</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> * id of the vector is stored.</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> * The inverted list object is required only after trainng. If none is</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> * set externally, an ArrayInvertedLists is used automatically.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<span class="comment"> * At search time, the vector to be searched is also quantized, and</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"> * only the list corresponding to the quantization index is</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment"> * searched. This speeds up the search by making it</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> * non-exhaustive. This can be relaxed using multi-probe search: a few</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> * (nprobe) quantization indices are selected and several inverted</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> * lists are visited.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> * Sub-classes implement a post-filtering of the index that refines</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * the distance estimation from the query to databse vectors.</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html">   90</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a>: <a class="code" href="structfaiss_1_1Index.html">Index</a>, <a class="code" href="structfaiss_1_1Level1Quantizer.html">Level1Quantizer</a> {<span class="comment"></span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment">    /// Acess to the actual data</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc">   92</a></span>&#160;<span class="comment"></span>    <a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *<a class="code" href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc">invlists</a>;</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;    <span class="keywordtype">bool</span> own_invlists;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">   95</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">code_size</a>;              <span class="comment">///&lt; code size per vector in bytes</span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#affed235eadf27a13d753ee4d33a1dc58">   97</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#affed235eadf27a13d753ee4d33a1dc58">nprobe</a>;            <span class="comment">///&lt; number of probes at query time</span></div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#a7f2dd34f66f8770acba74a0a591fa4a8">   98</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7f2dd34f66f8770acba74a0a591fa4a8">max_codes</a>;         <span class="comment">///&lt; max nb of codes to visit to do a query</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">    /** Parallel mode determines how queries are parallelized with OpenMP</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment">     * 0 (default): parallelize over queries</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment">     * 1: parallelize over over inverted lists</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment">     * 2: parallelize over both</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#a244ec2067da495ff1493687e0048ae02">  106</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a244ec2067da495ff1493687e0048ae02">parallel_mode</a>;</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment">    /// map for direct access to the elements. Enables reconstruct().</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVF.html#aedd0c14b5654295b291638ec7f9f9517">  109</a></span>&#160;<span class="comment"></span>    <span class="keywordtype">bool</span> <a class="code" href="structfaiss_1_1IndexIVF.html#aedd0c14b5654295b291638ec7f9f9517">maintain_direct_map</a>;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    std::vector &lt;idx_t&gt; direct_map;</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">    /** The Inverted file takes a quantizer (an Index) on input,</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment">     * which implements the function mapping a vector to a list</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment">     * identifier. The pointer is borrowed: the quantizer should not</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment">     * be deleted while the IndexIVF is in use.</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    <a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> (<a class="code" href="structfaiss_1_1Index.html">Index</a> * <a class="code" href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">quantizer</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">d</a>,</div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;              <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">nlist</a>, <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">code_size</a>,</div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;              <a class="code" href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">MetricType</a> metric = METRIC_L2);</div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a47a3b7665e9d2be41c6d3b2e9144b73f">reset</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment">    /// Trains the quantizer and calls train_residual to train sub-quantizers</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7a1d5eec194db0977b2318c6ed6a2b86">train</a>(idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment">    /// Calls add_with_ids with NULL ids</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a821002a9d3a1a74dc8d6f6072eca4075">add</a>(idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="comment">    /// default implementation that calls encode_vectors</span></div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a14e75169bddcd0251134821416b060a1">add_with_ids</a>(idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, <span class="keyword">const</span> idx_t* xids) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment">    /** Encodes a set of vectors as they would appear in the inverted lists</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment">     * @param list_nos   inverted list ids as returned by the</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">     *                   quantizer (size n). -1s are ignored.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">     * @param codes      output codes, size n * code_size</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a2f16f939a418d8e58ff43f4ee0dc17cc">encode_vectors</a>(idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x,</div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;                                <span class="keyword">const</span> idx_t *list_nos,</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;                                uint8_t * codes) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">    /// Sub-classes that encode the residuals can train their encoders here</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">    /// does nothing by default</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a567ef760fd09d09ce2ee4f4e6c2d7280">train_residual</a> (idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x);</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment">    /** search a set of vectors, that are pre-quantized by the IVF</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment">     *  quantizer. Fill in the corresponding heaps with the query</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">     *  results. The default implementation uses InvertedListScanners</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">     *  to do the search.</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;<span class="comment">     * @param n      nb of vectors to query</span></div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="comment">     * @param x      query vectors, size nx * d</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment">     * @param assign coarse quantization indices, size nx * nprobe</span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;<span class="comment">     * @param centroid_dis</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">     *               distances to coarse centroids, size nx * nprobe</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">     * @param distance</span></div>
<div class="line"><a name="l00157"></a><span class="lineno">  157</span>&#160;<span class="comment">     *               output distances, size n * k</span></div>
<div class="line"><a name="l00158"></a><span class="lineno">  158</span>&#160;<span class="comment">     * @param labels output labels, size n * k</span></div>
<div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;<span class="comment">     * @param store_pairs store inv list index + inv list offset</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment">     *                     instead in upper/lower 32 bit of result,</span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;<span class="comment">     *                     instead of ids (used for reranking).</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">     * @param params used to override the object&#39;s search parameters</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7cf3a1963394f87d61913420a66eb468">search_preassigned</a> (idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, idx_t k,</div>
<div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;                                     <span class="keyword">const</span> idx_t *<a class="code" href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">assign</a>,</div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;                                     <span class="keyword">const</span> <span class="keywordtype">float</span> *centroid_dis,</div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;                                     <span class="keywordtype">float</span> *distances, idx_t *labels,</div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;                                     <span class="keywordtype">bool</span> store_pairs,</div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;                                     <span class="keyword">const</span> <a class="code" href="structfaiss_1_1IVFSearchParameters.html">IVFSearchParameters</a> *params=<span class="keyword">nullptr</span></div>
<div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;                                     ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;<span class="comment">    /** assign the vectors, then call search_preassign */</span></div>
<div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#ae2fd47b7d52603659e269aa8f6abb613">search</a> (idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, idx_t k,</div>
<div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;                 <span class="keywordtype">float</span> *distances, idx_t *labels) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;</div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a5b7b4b3dc5ea40f7076a00c81cc83d66">range_search</a> (idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span>* x, <span class="keywordtype">float</span> radius,</div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;                       <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a>* result) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;</div>
<div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;    <span class="keywordtype">void</span> range_search_preassigned(idx_t nx, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, <span class="keywordtype">float</span> radius,</div>
<div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;                                  <span class="keyword">const</span> idx_t *keys, <span class="keyword">const</span> <span class="keywordtype">float</span> *coarse_dis,</div>
<div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;                                  <a class="code" href="structfaiss_1_1RangeSearchResult.html">RangeSearchResult</a> *result) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;<span class="comment">    /// get a scanner for this index (store_pairs means ignore labels)</span></div>
<div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <a class="code" href="structfaiss_1_1InvertedListScanner.html">InvertedListScanner</a> *<a class="code" href="structfaiss_1_1IndexIVF.html#abdf74276df83acf76023f105516fe881">get_InvertedListScanner</a> (</div>
<div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;        <span class="keywordtype">bool</span> store_pairs=<span class="keyword">false</span>) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;</div>
<div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a3b3270dcfa248dc30117644382a54e39">reconstruct</a> (idx_t key, <span class="keywordtype">float</span>* recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;<span class="comment">    /** Reconstruct a subset of the indexed vectors.</span></div>
<div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;<span class="comment">     * Overrides default implementation to bypass reconstruct() which requires</span></div>
<div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;<span class="comment">     * direct_map to be maintained.</span></div>
<div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;<span class="comment">     * @param i0     first vector to reconstruct</span></div>
<div class="line"><a name="l00195"></a><span class="lineno">  195</span>&#160;<span class="comment">     * @param ni     nb of vectors to reconstruct</span></div>
<div class="line"><a name="l00196"></a><span class="lineno">  196</span>&#160;<span class="comment">     * @param recons output array of reconstructed vectors, size ni * d</span></div>
<div class="line"><a name="l00197"></a><span class="lineno">  197</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00198"></a><span class="lineno">  198</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7cc286dfbd8bfd43ea4b22173e28231c">reconstruct_n</a>(idx_t i0, idx_t ni, <span class="keywordtype">float</span>* recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00199"></a><span class="lineno">  199</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00200"></a><span class="lineno">  200</span>&#160;<span class="comment">    /** Similar to search, but also reconstructs the stored vectors (or an</span></div>
<div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;<span class="comment">     * approximation in the case of lossy coding) for the search results.</span></div>
<div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;<span class="comment">     * Overrides default implementation to avoid having to maintain direct_map</span></div>
<div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;<span class="comment">     * and instead fetch the code offsets through the `store_pairs` flag in</span></div>
<div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;<span class="comment">     * search_preassigned().</span></div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;<span class="comment">     * @param recons      reconstructed vectors size (n, k, d)</span></div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a77aec24920024a09f7661790d9534c10">search_and_reconstruct</a> (idx_t n, <span class="keyword">const</span> <span class="keywordtype">float</span> *x, idx_t k,</div>
<div class="line"><a name="l00210"></a><span class="lineno">  210</span>&#160;                                 <span class="keywordtype">float</span> *distances, idx_t *labels,</div>
<div class="line"><a name="l00211"></a><span class="lineno">  211</span>&#160;                                 <span class="keywordtype">float</span> *recons) <span class="keyword">const override</span>;</div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;<span class="comment">    /** Reconstruct a vector given the location in terms of (inv list index +</span></div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment">     * inv list offset) instead of the id.</span></div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="comment">     * Useful for reconstructing when the direct_map is not maintained and</span></div>
<div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;<span class="comment">     * the inv list offset is computed by search_preassigned() with</span></div>
<div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;<span class="comment">     * `store_pairs` set.</span></div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#acaa919a002354a7944266c26f8965170">reconstruct_from_offset</a> (idx_t list_no, idx_t offset,</div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;                                          <span class="keywordtype">float</span>* recons) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;</div>
<div class="line"><a name="l00223"></a><span class="lineno">  223</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00224"></a><span class="lineno">  224</span>&#160;<span class="comment">    /// Dataset manipulation functions</span></div>
<div class="line"><a name="l00225"></a><span class="lineno">  225</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00226"></a><span class="lineno">  226</span>&#160;    idx_t <a class="code" href="structfaiss_1_1IndexIVF.html#a4e6f5ea9abc1a014531be989b5dea4b7">remove_ids</a>(<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IDSelector.html">IDSelector</a>&amp; sel) <span class="keyword">override</span>;</div>
<div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;<span class="comment">    /** check that the two indexes are compatible (ie, they are</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="comment">     * trained in the same way and have the same</span></div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;<span class="comment">     * parameters). Otherwise throw. */</span></div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a7fc8b9a1fff9f3d24cf7055fbc4fed7b">check_compatible_for_merge</a> (<span class="keyword">const</span> <a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> &amp;other) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00233"></a><span class="lineno">  233</span>&#160;<span class="comment">    /** moves the entries from another dataset to self. On output,</span></div>
<div class="line"><a name="l00234"></a><span class="lineno">  234</span>&#160;<span class="comment">     * other is empty. add_id is added to all moved ids (for</span></div>
<div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;<span class="comment">     * sequential ids, this would be this-&gt;ntotal */</span></div>
<div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a0f22cc237c30c935df5b6560aecf8f01">merge_from</a> (<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> &amp;other, idx_t add_id);</div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;<span class="comment">    /** copy a subset of the entries index to the other index</span></div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment">     * if subset_type == 0: copies ids in [a1, a2)</span></div>
<div class="line"><a name="l00241"></a><span class="lineno">  241</span>&#160;<span class="comment">     * if subset_type == 1: copies ids if id % a1 == a2</span></div>
<div class="line"><a name="l00242"></a><span class="lineno">  242</span>&#160;<span class="comment">     * if subset_type == 2: copies inverted lists such that a1</span></div>
<div class="line"><a name="l00243"></a><span class="lineno">  243</span>&#160;<span class="comment">     *                      elements are left before and a2 elements are after</span></div>
<div class="line"><a name="l00244"></a><span class="lineno">  244</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00245"></a><span class="lineno">  245</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#aa64ecc5e7b286e9b0f252796edd4714b">copy_subset_to</a> (<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> &amp; other, <span class="keywordtype">int</span> subset_type,</div>
<div class="line"><a name="l00246"></a><span class="lineno">  246</span>&#160;                                 idx_t a1, idx_t a2) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00247"></a><span class="lineno">  247</span>&#160;</div>
<div class="line"><a name="l00248"></a><span class="lineno">  248</span>&#160;    ~<a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a>() <span class="keyword">override</span>;</div>
<div class="line"><a name="l00249"></a><span class="lineno">  249</span>&#160;</div>
<div class="line"><a name="l00250"></a><span class="lineno">  250</span>&#160;    <span class="keywordtype">size_t</span> get_list_size (<span class="keywordtype">size_t</span> list_no)<span class="keyword"> const</span></div>
<div class="line"><a name="l00251"></a><span class="lineno">  251</span>&#160;<span class="keyword">    </span>{ <span class="keywordflow">return</span> <a class="code" href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc">invlists</a>-&gt;<a class="code" href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">list_size</a>(list_no); }</div>
<div class="line"><a name="l00252"></a><span class="lineno">  252</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;<span class="comment">    /** intialize a direct map</span></div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment">     * @param new_maintain_direct_map    if true, create a direct map,</span></div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">     *                                   else clear it</span></div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a1c11ce77f459e2ab3e5d9a4c2263ad89">make_direct_map</a> (<span class="keywordtype">bool</span> new_maintain_direct_map=<span class="keyword">true</span>);</div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;<span class="comment">    /// replace the inverted lists, old one is deallocated if own_invlists</span></div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;<span class="comment"></span>    <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1IndexIVF.html#a4eb943aeb7df30d44ad9b665452bfcf7">replace_invlists</a> (<a class="code" href="structfaiss_1_1InvertedLists.html">InvertedLists</a> *il, <span class="keywordtype">bool</span> own=<span class="keyword">false</span>);</div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;</div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;    <a class="code" href="structfaiss_1_1IndexIVF.html">IndexIVF</a> ();</div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;};</div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;</div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;<span class="keyword">struct </span>RangeQueryResult;</div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;<span class="comment">/** Object that handles a query. The inverted lists to scan are</span></div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;<span class="comment"> * provided externally. The object has a lot of state, but</span></div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;<span class="comment"> * distance_to_code and scan_codes can be called in multiple</span></div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;<span class="comment"> * threads */</span></div>
<div class="line"><a name="l00272"></a><span class="lineno"><a class="line" href="structfaiss_1_1InvertedListScanner.html">  272</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1InvertedListScanner.html">InvertedListScanner</a> {</div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;</div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;    <span class="keyword">using</span> idx_t = <a class="code" href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">Index::idx_t</a>;</div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="comment">    /// from now on we handle this query.</span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedListScanner.html#a97cab8fbf8203bdda6c42fc4b8f92319">set_query</a> (<span class="keyword">const</span> <span class="keywordtype">float</span> *query_vector) = 0;</div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;<span class="comment">    /// following codes come from this inverted list</span></div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedListScanner.html#ae801ea7ba0086a05ace3b779c3acf305">set_list</a> (idx_t list_no, <span class="keywordtype">float</span> coarse_dis) = 0;</div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="comment">    /// compute a single query-to-code distance</span></div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="comment"></span>    <span class="keyword">virtual</span> <span class="keywordtype">float</span> <a class="code" href="structfaiss_1_1InvertedListScanner.html#ade9518f1b0ee00c2a43a2eb2ae350ae1">distance_to_code</a> (<span class="keyword">const</span> uint8_t *code) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;<span class="comment">    /** scan a set of codes, compute distances to current query and</span></div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;<span class="comment">     * update heap of results if necessary.</span></div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;<span class="comment">     * @param n      number of codes to scan</span></div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="comment">     * @param codes  codes to scan (n * code_size)</span></div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;<span class="comment">     * @param ids        corresponding ids (ignored if store_pairs)</span></div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;<span class="comment">     * @param distances  heap distances (size k)</span></div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;<span class="comment">     * @param labels     heap labels (size k)</span></div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;<span class="comment">     * @param k          heap size</span></div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment">     * @return number of heap updates performed</span></div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;<span class="comment">     */</span></div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="structfaiss_1_1InvertedListScanner.html#a218aeaf7cc45bf0bf27c3a8bfa44e303">scan_codes</a> (<span class="keywordtype">size_t</span> n,</div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;                               <span class="keyword">const</span> uint8_t *codes,</div>
<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;                               <span class="keyword">const</span> idx_t *ids,</div>
<div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;                               <span class="keywordtype">float</span> *distances, idx_t *labels,</div>
<div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;                               <span class="keywordtype">size_t</span> k) <span class="keyword">const</span> = 0;</div>
<div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;<span class="comment">    /** scan a set of codes, compute distances to current query and</span></div>
<div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;<span class="comment">     * update results if distances are below radius</span></div>
<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment">     *</span></div>
<div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment">     * (default implementation fails) */</span></div>
<div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structfaiss_1_1InvertedListScanner.html#a57b6dcddab11cc801ce6288e065e1fa1">scan_codes_range</a> (<span class="keywordtype">size_t</span> n,</div>
<div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;                                   <span class="keyword">const</span> uint8_t *codes,</div>
<div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;                                   <span class="keyword">const</span> idx_t *ids,</div>
<div class="line"><a name="l00309"></a><span class="lineno">  309</span>&#160;                                   <span class="keywordtype">float</span> radius,</div>
<div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;                                   <a class="code" href="structfaiss_1_1RangeQueryResult.html">RangeQueryResult</a> &amp;result) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;</div>
<div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;    <span class="keyword">virtual</span> ~<a class="code" href="structfaiss_1_1InvertedListScanner.html">InvertedListScanner</a> () {}</div>
<div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;</div>
<div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;};</div>
<div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;</div>
<div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;</div>
<div class="line"><a name="l00317"></a><span class="lineno"><a class="line" href="structfaiss_1_1IndexIVFStats.html">  317</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfaiss_1_1IndexIVFStats.html">IndexIVFStats</a> {</div>
<div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;    <span class="keywordtype">size_t</span> nq;       <span class="comment">// nb of queries run</span></div>
<div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;    <span class="keywordtype">size_t</span> nlist;    <span class="comment">// nb of inverted lists scanned</span></div>
<div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160;    <span class="keywordtype">size_t</span> ndis;     <span class="comment">// nb of distancs computed</span></div>
<div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;    <span class="keywordtype">size_t</span> nheap_updates; <span class="comment">// nb of times the heap was updated</span></div>
<div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;    <span class="keywordtype">double</span> quantization_time; <span class="comment">// time spent quantizing vectors (in ms)</span></div>
<div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;    <span class="keywordtype">double</span> search_time;       <span class="comment">// time spent searching lists (in ms)</span></div>
<div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;</div>
<div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;    <a class="code" href="structfaiss_1_1IndexIVFStats.html">IndexIVFStats</a> () {reset (); }</div>
<div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;    <span class="keywordtype">void</span> reset ();</div>
<div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;};</div>
<div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;</div>
<div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;<span class="comment">// global var that collects them all</span></div>
<div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;<span class="keyword">extern</span> <a class="code" href="structfaiss_1_1IndexIVFStats.html">IndexIVFStats</a> indexIVF_stats;</div>
<div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;</div>
<div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;</div>
<div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;} <span class="comment">// namespace faiss</span></div>
<div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;</div>
<div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;</div>
<div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a2f16f939a418d8e58ff43f4ee0dc17cc"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a2f16f939a418d8e58ff43f4ee0dc17cc">faiss::IndexIVF::encode_vectors</a></div><div class="ttdeci">virtual void encode_vectors(idx_t n, const float *x, const idx_t *list_nos, uint8_t *codes) const =0</div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html">faiss::IndexIVF</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00090">IndexIVF.h:90</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a244ec2067da495ff1493687e0048ae02"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a244ec2067da495ff1493687e0048ae02">faiss::IndexIVF::parallel_mode</a></div><div class="ttdeci">int parallel_mode</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00106">IndexIVF.h:106</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7cf3a1963394f87d61913420a66eb468"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7cf3a1963394f87d61913420a66eb468">faiss::IndexIVF::search_preassigned</a></div><div class="ttdeci">virtual void search_preassigned(idx_t n, const float *x, idx_t k, const idx_t *assign, const float *centroid_dis, float *distances, idx_t *labels, bool store_pairs, const IVFSearchParameters *params=nullptr) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00250">IndexIVF.cpp:250</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html">faiss::Level1Quantizer</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00031">IndexIVF.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeQueryResult_html"><div class="ttname"><a href="structfaiss_1_1RangeQueryResult.html">faiss::RangeQueryResult</a></div><div class="ttdoc">result structure for a single query </div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00138">AuxIndexStructures.h:138</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7fc8b9a1fff9f3d24cf7055fbc4fed7b"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7fc8b9a1fff9f3d24cf7055fbc4fed7b">faiss::IndexIVF::check_compatible_for_merge</a></div><div class="ttdeci">void check_compatible_for_merge(const IndexIVF &amp;other) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00710">IndexIVF.cpp:710</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a77aec24920024a09f7661790d9534c10"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a77aec24920024a09f7661790d9534c10">faiss::IndexIVF::search_and_reconstruct</a></div><div class="ttdeci">void search_and_reconstruct(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00595">IndexIVF.cpp:595</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_affed235eadf27a13d753ee4d33a1dc58"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#affed235eadf27a13d753ee4d33a1dc58">faiss::IndexIVF::nprobe</a></div><div class="ttdeci">size_t nprobe</div><div class="ttdoc">number of probes at query time </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00097">IndexIVF.h:97</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c"><div class="ttname"><a href="structfaiss_1_1Index.html#a8bc5d8d1cd0dd7b34b3c98a9f76b4a9c">faiss::Index::assign</a></div><div class="ttdeci">void assign(idx_t n, const float *x, idx_t *labels, idx_t k=1)</div><div class="ttdef"><b>Definition:</b> <a href="Index_8cpp_source.html#l00034">Index.cpp:34</a></div></div>
<div class="ttc" id="structfaiss_1_1IDSelector_html"><div class="ttname"><a href="structfaiss_1_1IDSelector.html">faiss::IDSelector</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00054">AuxIndexStructures.h:54</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a4e6f5ea9abc1a014531be989b5dea4b7"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a4e6f5ea9abc1a014531be989b5dea4b7">faiss::IndexIVF::remove_ids</a></div><div class="ttdeci">idx_t remove_ids(const IDSelector &amp;sel) override</div><div class="ttdoc">Dataset manipulation functions. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00648">IndexIVF.cpp:648</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html_a9bd256053ee360473842105460fe285f"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html#a9bd256053ee360473842105460fe285f">faiss::InvertedLists::list_size</a></div><div class="ttdeci">virtual size_t list_size(size_t list_no) const =0</div><div class="ttdoc">get the size of a list </div></div>
<div class="ttc" id="structfaiss_1_1IndexIVFStats_html"><div class="ttname"><a href="structfaiss_1_1IndexIVFStats.html">faiss::IndexIVFStats</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00317">IndexIVF.h:317</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a3b3270dcfa248dc30117644382a54e39"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a3b3270dcfa248dc30117644382a54e39">faiss::IndexIVF::reconstruct</a></div><div class="ttdeci">void reconstruct(idx_t key, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00562">IndexIVF.cpp:562</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a567ef760fd09d09ce2ee4f4e6c2d7280"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a567ef760fd09d09ce2ee4f4e6c2d7280">faiss::IndexIVF::train_residual</a></div><div class="ttdeci">virtual void train_residual(idx_t n, const float *x)</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00703">IndexIVF.cpp:703</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a5b7b4b3dc5ea40f7076a00c81cc83d66"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a5b7b4b3dc5ea40f7076a00c81cc83d66">faiss::IndexIVF::range_search</a></div><div class="ttdeci">void range_search(idx_t n, const float *x, float radius, RangeSearchResult *result) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00434">IndexIVF.cpp:434</a></div></div>
<div class="ttc" id="structfaiss_1_1IVFSearchParameters_html"><div class="ttname"><a href="structfaiss_1_1IVFSearchParameters.html">faiss::IVFSearchParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00060">IndexIVF.h:60</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedLists_html"><div class="ttname"><a href="structfaiss_1_1InvertedLists.html">faiss::InvertedLists</a></div><div class="ttdef"><b>Definition:</b> <a href="InvertedLists_8h_source.html#l00031">InvertedLists.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_a2a002388d2c081c2dbab8508dcefe73d"><div class="ttname"><a href="structfaiss_1_1Index.html#a2a002388d2c081c2dbab8508dcefe73d">faiss::Index::d</a></div><div class="ttdeci">int d</div><div class="ttdoc">vector dimension </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00066">Index.h:66</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html_ad3f0d3071f987baabbdd3da4500c87ea"><div class="ttname"><a href="structfaiss_1_1Index.html#ad3f0d3071f987baabbdd3da4500c87ea">faiss::Index::idx_t</a></div><div class="ttdeci">long idx_t</div><div class="ttdoc">all indices are this type </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00062">Index.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_aa64ecc5e7b286e9b0f252796edd4714b"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#aa64ecc5e7b286e9b0f252796edd4714b">faiss::IndexIVF::copy_subset_to</a></div><div class="ttdeci">virtual void copy_subset_to(IndexIVF &amp;other, int subset_type, idx_t a1, idx_t a2) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00748">IndexIVF.cpp:748</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedListScanner_html_ade9518f1b0ee00c2a43a2eb2ae350ae1"><div class="ttname"><a href="structfaiss_1_1InvertedListScanner.html#ade9518f1b0ee00c2a43a2eb2ae350ae1">faiss::InvertedListScanner::distance_to_code</a></div><div class="ttdeci">virtual float distance_to_code(const uint8_t *code) const =0</div><div class="ttdoc">compute a single query-to-code distance </div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7a1d5eec194db0977b2318c6ed6a2b86"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7a1d5eec194db0977b2318c6ed6a2b86">faiss::IndexIVF::train</a></div><div class="ttdeci">void train(idx_t n, const float *x) override</div><div class="ttdoc">Trains the quantizer and calls train_residual to train sub-quantizers. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00688">IndexIVF.cpp:688</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7cc286dfbd8bfd43ea4b22173e28231c"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7cc286dfbd8bfd43ea4b22173e28231c">faiss::IndexIVF::reconstruct_n</a></div><div class="ttdeci">void reconstruct_n(idx_t i0, idx_t ni, float *recons) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00574">IndexIVF.cpp:574</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a1dcea762fc322fdcffe64f78994edea0"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a1dcea762fc322fdcffe64f78994edea0">faiss::Level1Quantizer::quantizer_trains_alone</a></div><div class="ttdeci">char quantizer_trains_alone</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00040">IndexIVF.h:40</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedListScanner_html_ae801ea7ba0086a05ace3b779c3acf305"><div class="ttname"><a href="structfaiss_1_1InvertedListScanner.html#ae801ea7ba0086a05ace3b779c3acf305">faiss::InvertedListScanner::set_list</a></div><div class="ttdeci">virtual void set_list(idx_t list_no, float coarse_dis)=0</div><div class="ttdoc">following codes come from this inverted list </div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a14e75169bddcd0251134821416b060a1"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a14e75169bddcd0251134821416b060a1">faiss::IndexIVF::add_with_ids</a></div><div class="ttdeci">void add_with_ids(idx_t n, const float *x, const idx_t *xids) override</div><div class="ttdoc">default implementation that calls encode_vectors </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00149">IndexIVF.cpp:149</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_abdf74276df83acf76023f105516fe881"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#abdf74276df83acf76023f105516fe881">faiss::IndexIVF::get_InvertedListScanner</a></div><div class="ttdeci">virtual InvertedListScanner * get_InvertedListScanner(bool store_pairs=false) const </div><div class="ttdoc">get a scanner for this index (store_pairs means ignore labels) </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00556">IndexIVF.cpp:556</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedListScanner_html_a218aeaf7cc45bf0bf27c3a8bfa44e303"><div class="ttname"><a href="structfaiss_1_1InvertedListScanner.html#a218aeaf7cc45bf0bf27c3a8bfa44e303">faiss::InvertedListScanner::scan_codes</a></div><div class="ttdeci">virtual size_t scan_codes(size_t n, const uint8_t *codes, const idx_t *ids, float *distances, idx_t *labels, size_t k) const =0</div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a4eb943aeb7df30d44ad9b665452bfcf7"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a4eb943aeb7df30d44ad9b665452bfcf7">faiss::IndexIVF::replace_invlists</a></div><div class="ttdeci">void replace_invlists(InvertedLists *il, bool own=false)</div><div class="ttdoc">replace the inverted lists, old one is deallocated if own_invlists </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00735">IndexIVF.cpp:735</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_abb7097ed40b15ba0af08af6d03608f72"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#abb7097ed40b15ba0af08af6d03608f72">faiss::Level1Quantizer::cp</a></div><div class="ttdeci">ClusteringParameters cp</div><div class="ttdoc">to override default clustering params </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00043">IndexIVF.h:43</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a47a3b7665e9d2be41c6d3b2e9144b73f"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a47a3b7665e9d2be41c6d3b2e9144b73f">faiss::IndexIVF::reset</a></div><div class="ttdeci">void reset() override</div><div class="ttdoc">removes all elements from the database. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00640">IndexIVF.cpp:640</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a45d29dd6a5c53789c08e5ceb3f63d989"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a45d29dd6a5c53789c08e5ceb3f63d989">faiss::Level1Quantizer::clustering_index</a></div><div class="ttdeci">Index * clustering_index</div><div class="ttdoc">to override index used during clustering </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00044">IndexIVF.h:44</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedListScanner_html"><div class="ttname"><a href="structfaiss_1_1InvertedListScanner.html">faiss::InvertedListScanner</a></div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00272">IndexIVF.h:272</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a0069a6ee1e32c2e0c1c7df9a95740dd4"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a0069a6ee1e32c2e0c1c7df9a95740dd4">faiss::Level1Quantizer::train_q1</a></div><div class="ttdeci">void train_q1(size_t n, const float *x, bool verbose, MetricType metric_type)</div><div class="ttdoc">Trains the quantizer and calls train_residual to train sub-quantizers. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00060">IndexIVF.cpp:60</a></div></div>
<div class="ttc" id="structfaiss_1_1IVFSearchParameters_html_a1183c0b7d9ffd5154b32765175f2a9cc"><div class="ttname"><a href="structfaiss_1_1IVFSearchParameters.html#a1183c0b7d9ffd5154b32765175f2a9cc">faiss::IVFSearchParameters::nprobe</a></div><div class="ttdeci">size_t nprobe</div><div class="ttdoc">number of probes at query time </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00061">IndexIVF.h:61</a></div></div>
<div class="ttc" id="structfaiss_1_1RangeSearchResult_html"><div class="ttname"><a href="structfaiss_1_1RangeSearchResult.html">faiss::RangeSearchResult</a></div><div class="ttdef"><b>Definition:</b> <a href="AuxIndexStructures_8h_source.html#l00031">AuxIndexStructures.h:31</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a1c11ce77f459e2ab3e5d9a4c2263ad89"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a1c11ce77f459e2ab3e5d9a4c2263ad89">faiss::IndexIVF::make_direct_map</a></div><div class="ttdeci">void make_direct_map(bool new_maintain_direct_map=true)</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00202">IndexIVF.cpp:202</a></div></div>
<div class="ttc" id="structfaiss_1_1ClusteringParameters_html"><div class="ttname"><a href="structfaiss_1_1ClusteringParameters.html">faiss::ClusteringParameters</a></div><div class="ttdef"><b>Definition:</b> <a href="Clustering_8h_source.html#l00022">Clustering.h:22</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_aa0e8fc5e04cbd8e0dde61f98bc7dd0bc"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#aa0e8fc5e04cbd8e0dde61f98bc7dd0bc">faiss::IndexIVF::invlists</a></div><div class="ttdeci">InvertedLists * invlists</div><div class="ttdoc">Acess to the actual data. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00092">IndexIVF.h:92</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_acaa919a002354a7944266c26f8965170"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#acaa919a002354a7944266c26f8965170">faiss::IndexIVF::reconstruct_from_offset</a></div><div class="ttdeci">virtual void reconstruct_from_offset(idx_t list_no, idx_t offset, float *recons) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00633">IndexIVF.cpp:633</a></div></div>
<div class="ttc" id="structfaiss_1_1Index_html"><div class="ttname"><a href="structfaiss_1_1Index.html">faiss::Index</a></div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00061">Index.h:61</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a821002a9d3a1a74dc8d6f6072eca4075"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a821002a9d3a1a74dc8d6f6072eca4075">faiss::IndexIVF::add</a></div><div class="ttdeci">void add(idx_t n, const float *x) override</div><div class="ttdoc">Calls add_with_ids with NULL ids. </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00143">IndexIVF.cpp:143</a></div></div>
<div class="ttc" id="structfaiss_1_1IVFSearchParameters_html_ac3e01728f6376ad727340525b2138782"><div class="ttname"><a href="structfaiss_1_1IVFSearchParameters.html#ac3e01728f6376ad727340525b2138782">faiss::IVFSearchParameters::max_codes</a></div><div class="ttdeci">size_t max_codes</div><div class="ttdoc">max nb of codes to visit to do a query </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00062">IndexIVF.h:62</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a3cf99e2ee92b8558a066f821efab95d5"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a3cf99e2ee92b8558a066f821efab95d5">faiss::Level1Quantizer::quantizer</a></div><div class="ttdeci">Index * quantizer</div><div class="ttdoc">quantizer that maps vectors to inverted lists </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00032">IndexIVF.h:32</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a7f2dd34f66f8770acba74a0a591fa4a8"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a7f2dd34f66f8770acba74a0a591fa4a8">faiss::IndexIVF::max_codes</a></div><div class="ttdeci">size_t max_codes</div><div class="ttdoc">max nb of codes to visit to do a query </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00098">IndexIVF.h:98</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_aedd0c14b5654295b291638ec7f9f9517"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#aedd0c14b5654295b291638ec7f9f9517">faiss::IndexIVF::maintain_direct_map</a></div><div class="ttdeci">bool maintain_direct_map</div><div class="ttdoc">map for direct access to the elements. Enables reconstruct(). </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00109">IndexIVF.h:109</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_ab688c629cd42122d73517078b87f483d"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#ab688c629cd42122d73517078b87f483d">faiss::Level1Quantizer::own_fields</a></div><div class="ttdeci">bool own_fields</div><div class="ttdoc">whether object owns the quantizer </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00041">IndexIVF.h:41</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedListScanner_html_a97cab8fbf8203bdda6c42fc4b8f92319"><div class="ttname"><a href="structfaiss_1_1InvertedListScanner.html#a97cab8fbf8203bdda6c42fc4b8f92319">faiss::InvertedListScanner::set_query</a></div><div class="ttdeci">virtual void set_query(const float *query_vector)=0</div><div class="ttdoc">from now on we handle this query. </div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_ae2fd47b7d52603659e269aa8f6abb613"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#ae2fd47b7d52603659e269aa8f6abb613">faiss::IndexIVF::search</a></div><div class="ttdeci">void search(idx_t n, const float *x, idx_t k, float *distances, idx_t *labels) const override</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00228">IndexIVF.cpp:228</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a0f22cc237c30c935df5b6560aecf8f01"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a0f22cc237c30c935df5b6560aecf8f01">faiss::IndexIVF::merge_from</a></div><div class="ttdeci">virtual void merge_from(IndexIVF &amp;other, idx_t add_id)</div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00721">IndexIVF.cpp:721</a></div></div>
<div class="ttc" id="structfaiss_1_1Level1Quantizer_html_a1c4fc9d874d9492ee0ea27a5be388fa7"><div class="ttname"><a href="structfaiss_1_1Level1Quantizer.html#a1c4fc9d874d9492ee0ea27a5be388fa7">faiss::Level1Quantizer::nlist</a></div><div class="ttdeci">size_t nlist</div><div class="ttdoc">number of possible key values </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00033">IndexIVF.h:33</a></div></div>
<div class="ttc" id="structfaiss_1_1IndexIVF_html_a46d1aeddb60643c5b3f096147c3e028f"><div class="ttname"><a href="structfaiss_1_1IndexIVF.html#a46d1aeddb60643c5b3f096147c3e028f">faiss::IndexIVF::code_size</a></div><div class="ttdeci">size_t code_size</div><div class="ttdoc">code size per vector in bytes </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8h_source.html#l00095">IndexIVF.h:95</a></div></div>
<div class="ttc" id="structfaiss_1_1InvertedListScanner_html_a57b6dcddab11cc801ce6288e065e1fa1"><div class="ttname"><a href="structfaiss_1_1InvertedListScanner.html#a57b6dcddab11cc801ce6288e065e1fa1">faiss::InvertedListScanner::scan_codes_range</a></div><div class="ttdeci">virtual void scan_codes_range(size_t n, const uint8_t *codes, const idx_t *ids, float radius, RangeQueryResult &amp;result) const </div><div class="ttdef"><b>Definition:</b> <a href="IndexIVF_8cpp_source.html#l00830">IndexIVF.cpp:830</a></div></div>
<div class="ttc" id="namespacefaiss_html_afd12191c638da74760ff397cf319752c"><div class="ttname"><a href="namespacefaiss.html#afd12191c638da74760ff397cf319752c">faiss::MetricType</a></div><div class="ttdeci">MetricType</div><div class="ttdoc">Some algorithms support both an inner product version and a L2 search version. </div><div class="ttdef"><b>Definition:</b> <a href="Index_8h_source.html#l00044">Index.h:44</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
